🧰 Changes

This finally does what we've been talking about for months and adds an extremely lightweight wrapper around this repo so we can have first-class support for GitHub Actions 🚀

You can check out action.yml for all the heavy lifting.

Here's how uploading an OpenAPI file looks with npx vs. the GitHub Action:

# npx
- run: npx -y rdme@6 openapi openapi.json --key=API_KEY --id=API_SETTING_ID

# GitHub Action (🆕!)
- uses: readmeio/rdme@6
  with:
    rdme: openapi openapi.json --key=API_KEY --id=API_SETTING_ID

# GitHub Action (legacy)
- uses: readmeio/github-readme-sync@v2
  with:
    readme-oas-key: 'API_KEY:API_SETTING_ID'
    oas-file-path: openapi.json

I think I prefer the npx notation to be honest, but there are a few benefits of this new wrapper we've created:

• Users can configure our good friend dependabot to keep their version up-to-date (and I don't think this is possible with inline run: npx commands in your GitHub workflow files, unless they list rdme in their dev-deps)
• We can position rdme as a first-class GitHub Actions integration, rather than a workaround, meaning we can...
  • list this in the GitHub Actions Marketplace 🛍️
  • safely destroy [redacted] once and for all 🚮

🧬 QA & Testing

I added a little workflow file for testing this GitHub Action integration and it works as expected. It checks out the oas-examples repo, checks out the current branch of rdme, and runs our validate and openapi commands against a petstore.json OAS file in a GitHub Action environment ✨ this should be comprehensive enough for our purposes, but I'm open to other ideas here!

Additionally, we now specify the User-Agent header based on the environment, so I added tests for that (and consolidated logic and improved tests for that code) in this PR.

You're welcome to try this out in a separate repo (see here for how I did it)... but if all tests pass then we should be good to go!

Fixes RM-3566